Skip to content

doc: add "Do I still need this dependency for my Node.js app?" to ambassadors program #57600

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 8 commits into from

Conversation

bmuenzenmeyer
Copy link
Contributor

@bmuenzenmeyer bmuenzenmeyer commented Mar 23, 2025

Also included is:

  • a632929 - fixing some typos in previous content
  • 20c83cf - normalizing the markdown headers. without this, the levels bled into one another incorrectly (⬇️ now fixed)
    image

I chose to include all this together for review clarity and noise, but open to feedback of any kind. Cheers!
Understand most of this won't be acted upon until after collab summit, but I wanted to follow through here.

@nodejs-github-bot
Copy link
Collaborator

Review requested:

  • @nodejs/tsc

@nodejs-github-bot nodejs-github-bot added the doc Issues and PRs related to the documentations. label Mar 23, 2025
@bmuenzenmeyer
Copy link
Contributor Author

bmuenzenmeyer commented Mar 23, 2025

make does not work on my Windows machine, so trying to approximate it with node tools/lint-md/lint-md.mjs --format .\doc\contributing\advocacy-ambassador-program.md 🤞

Copy link
Member

@bjohansebas bjohansebas left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm :)

| [parsing arguments](https://nodejs.org/api/util.html#utilparseargsconfig) | [18.3.0](https://nodejs.org/en/blog/release/v18.3.0) | Stable as of 20.0.0 |
| [reading environment](https://nodejs.org/api/cli.html#--env-fileconfig) | [20.6.0](https://nodejs.org/en/blog/release/v20.6.0) | Active Development |
| [styling output](https://nodejs.org/docs/latest-v22.x/api/util.html#utilstyletextformat-text-options) | [20.12.0](https://nodejs.org/en/blog/release/v20.12.0) | Stable, as of [22.13.0](https://github.com/nodejs/node/pull/56329) |
| [run TypeScript](https://nodejs.org/api/cli.html#--experimental-strip-types) | [22.6.0](https://nodejs.org/en/blog/release/v22.6.0) | Active Development |
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Npm run vs. Node --run can be added as well

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agree that this is a useful addition, and did discuss it within https://noti.st/brianmuenzenmeyer/5ep4ZM/do-i-still-need-this-dependency-for-my-node-js-app - though I question whether most would describe their package manager as a dependency. Not trying to be pedantic.

The angle I took in the talk was that node --run does make documentation a bit more flexible, so that's an obvious plus.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

added via 2d049d4

@bmuenzenmeyer bmuenzenmeyer changed the title doc: add "do i still need this node.js dependency?" to ambassadors program doc: add "Do I still need this dependency for my Node.js app?" to ambassadors program Mar 24, 2025
Copy link
Member

@mhdawson mhdawson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@bmuenzenmeyer
Copy link
Contributor Author

bmuenzenmeyer commented May 3, 2025

presented today at Minnestar 19 in Minneapolis, MN

Overhwelming feedback from the standing-room only crowd was that they wished there was an official list of this somewhere.

https://noti.st/brianmuenzenmeyer/5ep4ZM/do-i-still-need-this-dependency-for-my-node-js-app

@mhdawson
Copy link
Member

mhdawson commented May 5, 2025

@bmuenzenmeyer there are a few suggestions/comments on the PR. If you could address them we could get this landed.

@bmuenzenmeyer
Copy link
Contributor Author

bmuenzenmeyer commented May 6, 2025

@bmuenzenmeyer there are a few suggestions/comments on the PR. If you could address them we could get this landed.

done - of course the TypeScript stuff especially is a moving target, with Node.js 23.6.0 unflagging strip typing, and transform types now available too. I suggest when this is taken up by an ambassador or more formally adopted, features on the newer side should be audited for similar relevancy.

mhdawson pushed a commit that referenced this pull request May 6, 2025
PR-URL: #57600
Reviewed-By: Moshe Atlow <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Marco Ippolito <[email protected]>
@mhdawson
Copy link
Member

mhdawson commented May 6, 2025

Landed as 9148e965b41dfb322a9e1f38dfaf11ddab0f042c

@mhdawson mhdawson closed this May 6, 2025
aduh95 pushed a commit that referenced this pull request May 8, 2025
PR-URL: #57600
Reviewed-By: Moshe Atlow <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Marco Ippolito <[email protected]>
aduh95 pushed a commit that referenced this pull request May 19, 2025
PR-URL: #57600
Reviewed-By: Moshe Atlow <[email protected]>
Reviewed-By: Michael Dawson <[email protected]>
Reviewed-By: Marco Ippolito <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Issues and PRs related to the documentations.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants